Skip to content

docs: fix README Examples issues #1076

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 31, 2024

Conversation

MikeMcC399
Copy link
Collaborator

@MikeMcC399 MikeMcC399 commented May 30, 2024

Issues

In the README > Examples section ...

  • The first paragraph
    • is not referring to examples, so it is misplaced in this section
    • misleadingly says you need to install Cypress which is not true for cypress/included
  • The link to Check out our docs for examples. links to https://on.cypress.io/docker where there are no examples to be found.
  • The following paragraph refers to an outdated legacy blog (see also PR docs: refresh included readme #1070):

    If you want to use the cypress/included image, read Run Cypress with a single Docker command

  • The set of 4 examples in the examples directory are based on cypress/included:3.8.0. This is a legacy version and the Cypress Docker images were generated before the introduction of cypress/factory. The issues, that the examples set out to address, take on a different form under non-legacy (current) versions of cypress/included:13.x generated through the cypress/factory process.
  • Providing only examples for cypress/included is unbalanced, when there are no examples listed for using cypress/base or cypress/browsers.

Changes

In the README > Examples section ...

  1. Remove the first three paragraphs.
  2. Replace with a link to the included/README.
  3. Move the legacy examples/included* to the included/README and mark them as legacy for the time being.
  4. Rework the included/README > Default user section and refer to the moved examples to avoid duplication.

@cypress-app-bot
Copy link

@MikeMcC399 MikeMcC399 self-assigned this May 30, 2024
@MikeMcC399 MikeMcC399 force-pushed the readme-examples-text branch 2 times, most recently from 0d9b1d5 to 787e2c0 Compare May 30, 2024 08:31
@MikeMcC399 MikeMcC399 marked this pull request as ready for review May 30, 2024 09:31
@MikeMcC399 MikeMcC399 marked this pull request as draft May 30, 2024 12:48
@MikeMcC399 MikeMcC399 force-pushed the readme-examples-text branch 3 times, most recently from e69974f to ac21e5c Compare May 30, 2024 14:40
@MikeMcC399 MikeMcC399 force-pushed the readme-examples-text branch from ac21e5c to 325557a Compare May 30, 2024 14:42
@MikeMcC399 MikeMcC399 marked this pull request as ready for review May 30, 2024 14:57
@jennifer-shehane jennifer-shehane merged commit 201276e into cypress-io:master May 31, 2024
31 checks passed
@MikeMcC399 MikeMcC399 deleted the readme-examples-text branch May 31, 2024 04:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants